com.inscoper.nbo.Image¶

Represents the XML element Image. More...

Inherits from com.inscoper.nbo.NBOBaseClass

Public Functions¶

	Name
synchronized void	delete()
	Image()
String	getTypeName() Returns the class type name.
String	getXMLName() Returns the XML element name corresponding to this class.
ENBOType	getNBOType() Returns the NBO Type corresponding to this class.
NBOBaseClassVector	getChildren() Returns a list of all classes derived from this class.
NBOBaseClassVector	getSubElements() Returns a list of all child elements contained in this class.
void	fromJsonFile(String path, boolean validate) Populates this object from a JSON file.
void	fromJsonFile(String path) Populates this object from a JSON file.
void	fromJsonString(String json_string, boolean validate) Populates this object from a JSON string.
void	fromJsonString(String json_string) Populates this object from a JSON string.
void	fromXmlFile(String path, boolean validate) Populates this object from a XML file.
void	fromXmlFile(String path) Populates this object from a XML file.
void	fromXmlString(String xml_string, boolean validate) Populates this object from a XML string.
void	fromXmlString(String xml_string) Populates this object from a XML string.
void	toXmlFile(String filename, boolean validate) Serializes this object to an XML file.
void	toXmlFile(String filename) Serializes this object to an XML file.
String	toXmlString(boolean validate) Serializes this object to an XML string.
String	toXmlString() Serializes this object to an XML string.
void	setID(ImageID_Type value, boolean validate) Sets the value of the ID attribute.
void	setID(ImageID_Type value) Sets the value of the ID attribute.
ImageID_Type	getID() Returns the value of the ID attribute.
void	resetID() Resets the ID attribute to an unset state.
boolean	hasID() Checks whether the optional ID attribute is present.
void	setName(Denomination_Type value, boolean validate) Sets the value of the Name attribute.
void	setName(Denomination_Type value) Sets the value of the Name attribute.
Denomination_Type	getName() Returns the value of the Name attribute.
void	resetName() Resets the Name attribute to an unset state.
boolean	hasName() Checks whether the optional Name attribute is present.
void	setAcquisitionDate(String value, boolean validate) Sets the value of the AcquisitionDate attribute.
void	setAcquisitionDate(String value) Sets the value of the AcquisitionDate attribute.
String	getAcquisitionDate() Returns the value of the AcquisitionDate attribute.
void	resetAcquisitionDate() Resets the AcquisitionDate attribute to an unset state.
boolean	hasAcquisitionDate() Checks whether the AcquisitionDate attribute is present.
void	setInstrumentRef(InstrumentRef value, boolean validate) Sets the value of the InstrumentRef element.
void	setInstrumentRef(InstrumentRef value) Sets the value of the InstrumentRef element.
InstrumentRef	getInstrumentRef() Returns the value of the InstrumentRef element.
void	resetInstrumentRef() Resets the InstrumentRef element to an unset state.
boolean	hasInstrumentRef() Checks whether the optional InstrumentRef element is present.
void	setExperimentRef(ExperimentRef value, boolean validate) Sets the value of the ExperimentRef element.
void	setExperimentRef(ExperimentRef value) Sets the value of the ExperimentRef element.
ExperimentRef	getExperimentRef() Returns the value of the ExperimentRef element.
void	resetExperimentRef() Resets the ExperimentRef element to an unset state.
boolean	hasExperimentRef() Checks whether the optional ExperimentRef element is present.
void	setExperimenterRef_List(ExperimenterRefVector value, boolean validate) Sets the list of ExperimenterRef elements.
void	setExperimenterRef_List(ExperimenterRefVector value) Sets the list of ExperimenterRef elements.
ExperimenterRefVector	getExperimenterRef_List() Returns the list of ExperimenterRef elements.
void	addToExperimenterRef_List(ExperimenterRef value, boolean validate) Adds a new ExperimenterRef element to this object.
void	addToExperimenterRef_List(ExperimenterRef value) Adds a new ExperimenterRef element to this object.
void	clearExperimenterRef_List() Clear the list of ExperimenterRef.
void	setSampleRef_List(SampleRefVector value, boolean validate) Sets the list of SampleRef elements.
void	setSampleRef_List(SampleRefVector value) Sets the list of SampleRef elements.
SampleRefVector	getSampleRef_List() Returns the list of SampleRef elements.
void	addToSampleRef_List(SampleRef value, boolean validate) Adds a new SampleRef element to this object.
void	addToSampleRef_List(SampleRef value) Adds a new SampleRef element to this object.
void	clearSampleRef_List() Clear the list of SampleRef.
void	setExperimenterGroupRef_List(ExperimenterGroupRefVector value, boolean validate) Sets the list of ExperimenterGroupRef elements.
void	setExperimenterGroupRef_List(ExperimenterGroupRefVector value) Sets the list of ExperimenterGroupRef elements.
ExperimenterGroupRefVector	getExperimenterGroupRef_List() Returns the list of ExperimenterGroupRef elements.
void	addToExperimenterGroupRef_List(ExperimenterGroupRef value, boolean validate) Adds a new ExperimenterGroupRef element to this object.
void	addToExperimenterGroupRef_List(ExperimenterGroupRef value) Adds a new ExperimenterGroupRef element to this object.
void	clearExperimenterGroupRef_List() Clear the list of ExperimenterGroupRef.
void	setROIRef_List(ROIRefVector value, boolean validate) Sets the list of ROIRef elements.
void	setROIRef_List(ROIRefVector value) Sets the list of ROIRef elements.
ROIRefVector	getROIRef_List() Returns the list of ROIRef elements.
void	addToROIRef_List(ROIRef value, boolean validate) Adds a new ROIRef element to this object.
void	addToROIRef_List(ROIRef value) Adds a new ROIRef element to this object.
void	clearROIRef_List() Clear the list of ROIRef.
void	setStageInsertRef_List(StageInsertRefVector value, boolean validate) Sets the list of StageInsertRef elements.
void	setStageInsertRef_List(StageInsertRefVector value) Sets the list of StageInsertRef elements.
StageInsertRefVector	getStageInsertRef_List() Returns the list of StageInsertRef elements.
void	addToStageInsertRef_List(StageInsertRef value, boolean validate) Adds a new StageInsertRef element to this object.
void	addToStageInsertRef_List(StageInsertRef value) Adds a new StageInsertRef element to this object.
void	clearStageInsertRef_List() Clear the list of StageInsertRef.
void	setFocusStabilizationDeviceRef_List(FocusStabilizationDeviceRefVector value, boolean validate) Sets the list of FocusStabilizationDeviceRef elements.
void	setFocusStabilizationDeviceRef_List(FocusStabilizationDeviceRefVector value) Sets the list of FocusStabilizationDeviceRef elements.
FocusStabilizationDeviceRefVector	getFocusStabilizationDeviceRef_List() Returns the list of FocusStabilizationDeviceRef elements.
void	addToFocusStabilizationDeviceRef_List(FocusStabilizationDeviceRef value, boolean validate) Adds a new FocusStabilizationDeviceRef element to this object.
void	addToFocusStabilizationDeviceRef_List(FocusStabilizationDeviceRef value) Adds a new FocusStabilizationDeviceRef element to this object.
void	clearFocusStabilizationDeviceRef_List() Clear the list of FocusStabilizationDeviceRef.
void	setAcquisitionSoftwareRef_List(AcquisitionSoftwareRefVector value, boolean validate) Sets the list of AcquisitionSoftwareRef elements.
void	setAcquisitionSoftwareRef_List(AcquisitionSoftwareRefVector value) Sets the list of AcquisitionSoftwareRef elements.
AcquisitionSoftwareRefVector	getAcquisitionSoftwareRef_List() Returns the list of AcquisitionSoftwareRef elements.
void	addToAcquisitionSoftwareRef_List(AcquisitionSoftwareRef value, boolean validate) Adds a new AcquisitionSoftwareRef element to this object.
void	addToAcquisitionSoftwareRef_List(AcquisitionSoftwareRef value) Adds a new AcquisitionSoftwareRef element to this object.
void	clearAcquisitionSoftwareRef_List() Clear the list of AcquisitionSoftwareRef.
void	setDescription(Description value, boolean validate) Sets the value of the Description element.
void	setDescription(Description value) Sets the value of the Description element.
Description	getDescription() Returns the value of the Description element.
void	resetDescription() Resets the Description element to an unset state.
boolean	hasDescription() Checks whether the optional Description element is present.
void	setImagingEnvironment_List(ImagingEnvironmentVector value, boolean validate) Sets the list of ImagingEnvironment elements.
void	setImagingEnvironment_List(ImagingEnvironmentVector value) Sets the list of ImagingEnvironment elements.
ImagingEnvironmentVector	getImagingEnvironment_List() Returns the list of ImagingEnvironment elements.
void	addToImagingEnvironment_List(ImagingEnvironment value, boolean validate) Adds a new ImagingEnvironment element to this object.
void	addToImagingEnvironment_List(ImagingEnvironment value) Adds a new ImagingEnvironment element to this object.
void	clearImagingEnvironment_List() Clear the list of ImagingEnvironment.
void	setMicroscopeStandSettings(MicroscopeStandSettings value, boolean validate) Sets the value of the MicroscopeStandSettings element.
void	setMicroscopeStandSettings(MicroscopeStandSettings value) Sets the value of the MicroscopeStandSettings element.
MicroscopeStandSettings	getMicroscopeStandSettings() Returns the value of the MicroscopeStandSettings element.
void	resetMicroscopeStandSettings() Resets the MicroscopeStandSettings element to an unset state.
boolean	hasMicroscopeStandSettings() Checks whether the optional MicroscopeStandSettings element is present.
void	setMicroscopeTableSettings_List(MicroscopeTableSettingsVector value, boolean validate) Sets the list of MicroscopeTableSettings elements.
void	setMicroscopeTableSettings_List(MicroscopeTableSettingsVector value) Sets the list of MicroscopeTableSettings elements.
MicroscopeTableSettingsVector	getMicroscopeTableSettings_List() Returns the list of MicroscopeTableSettings elements.
void	addToMicroscopeTableSettings_List(MicroscopeTableSettings value, boolean validate) Adds a new MicroscopeTableSettings element to this object.
void	addToMicroscopeTableSettings_List(MicroscopeTableSettings value) Adds a new MicroscopeTableSettings element to this object.
void	clearMicroscopeTableSettings_List() Clear the list of MicroscopeTableSettings.
void	setObjectiveSettings(ObjectiveSettings value, boolean validate) Sets the value of the ObjectiveSettings element.
void	setObjectiveSettings(ObjectiveSettings value) Sets the value of the ObjectiveSettings element.
ObjectiveSettings	getObjectiveSettings() Returns the value of the ObjectiveSettings element.
void	resetObjectiveSettings() Resets the ObjectiveSettings element to an unset state.
boolean	hasObjectiveSettings() Checks whether the optional ObjectiveSettings element is present.
void	setStageLabel_List(StageLabelVector value, boolean validate) Sets the list of StageLabel elements.
void	setStageLabel_List(StageLabelVector value) Sets the list of StageLabel elements.
StageLabelVector	getStageLabel_List() Returns the list of StageLabel elements.
void	addToStageLabel_List(StageLabel value, boolean validate) Adds a new StageLabel element to this object.
void	addToStageLabel_List(StageLabel value) Adds a new StageLabel element to this object.
void	clearStageLabel_List() Clear the list of StageLabel.
void	setSamplePositioningSettings_List(SamplePositioningSettingsVector value, boolean validate) Sets the list of SamplePositioningSettings elements.
void	setSamplePositioningSettings_List(SamplePositioningSettingsVector value) Sets the list of SamplePositioningSettings elements.
SamplePositioningSettingsVector	getSamplePositioningSettings_List() Returns the list of SamplePositioningSettings elements.
void	addToSamplePositioningSettings_List(SamplePositioningSettings value, boolean validate) Adds a new SamplePositioningSettings element to this object.
void	addToSamplePositioningSettings_List(SamplePositioningSettings value) Adds a new SamplePositioningSettings element to this object.
void	clearSamplePositioningSettings_List() Clear the list of SamplePositioningSettings.
void	setOpticalCalibration_List(OpticalCalibrationVector value, boolean validate) Sets the list of OpticalCalibration elements.
void	setOpticalCalibration_List(OpticalCalibrationVector value) Sets the list of OpticalCalibration elements.
OpticalCalibrationVector	getOpticalCalibration_List() Returns the list of OpticalCalibration elements.
void	addToOpticalCalibration_List(OpticalCalibration value, boolean validate) Adds a new OpticalCalibration element to this object.
void	addToOpticalCalibration_List(OpticalCalibration value) Adds a new OpticalCalibration element to this object.
void	clearOpticalCalibration_List() Clear the list of OpticalCalibration.
void	setDetectorCalibration_List(DetectorCalibrationVector value, boolean validate) Sets the list of DetectorCalibration elements.
void	setDetectorCalibration_List(DetectorCalibrationVector value) Sets the list of DetectorCalibration elements.
DetectorCalibrationVector	getDetectorCalibration_List() Returns the list of DetectorCalibration elements.
void	addToDetectorCalibration_List(DetectorCalibration value, boolean validate) Adds a new DetectorCalibration element to this object.
void	addToDetectorCalibration_List(DetectorCalibration value) Adds a new DetectorCalibration element to this object.
void	clearDetectorCalibration_List() Clear the list of DetectorCalibration.
void	setPixels(Pixels value, boolean validate) Sets the value of the Pixels element.
void	setPixels(Pixels value) Sets the value of the Pixels element.
Pixels	getPixels() Returns the value of the Pixels element.
void	resetPixels() Resets the Pixels element to an unset state.
boolean	hasPixels() Checks whether the optional Pixels element is present.
void	setAnnotationRef_List(AnnotationRefVector value, boolean validate) Sets the list of AnnotationRef elements.
void	setAnnotationRef_List(AnnotationRefVector value) Sets the list of AnnotationRef elements.
AnnotationRefVector	getAnnotationRef_List() Returns the list of AnnotationRef elements.
void	addToAnnotationRef_List(AnnotationRef value, boolean validate) Adds a new AnnotationRef element to this object.
void	addToAnnotationRef_List(AnnotationRef value) Adds a new AnnotationRef element to this object.
void	clearAnnotationRef_List() Clear the list of AnnotationRef.
Image	__internal_create(long cPtr, boolean own)
Image	fromBase(NBOBaseClass base) Cast a NBOBaseClass to a CMOS.
StringSet	getAcquisitionDateAllowedValues() Returns the allowed values for this attribut.

Protected Functions¶

	Name
	Image(long cPtr, boolean cMemoryOwn)
void	swigSetCMemOwn(boolean own)
void	finalize()
long	getCPtr(Image obj)

Additional inherited members¶

Protected Functions inherited from com.inscoper.nbo.NBOBaseClass

	Name
	NBOBaseClass(long cPtr, boolean cMemoryOwn)

Detailed Description¶

public class com.inscoper.nbo.Image;

Represents the XML element Image.

This element describes the actual Image that was acquired and its meta-data. The elements that are references (ending in Ref or Settings) refer to elements defined outside of the Image element. Ref elements are simple links, while Settings elements are links with additional values. If any of the required Image attributes or elements are missing, its guaranteed to be an invalid document.

Public Functions Documentation¶

function delete¶

public synchronized void delete()

Reimplements: com.inscoper.nbo.NBOBaseClass.delete

function Image¶

public Image()

function getTypeName¶

public String getTypeName()

Returns the class type name.

Return: The class type name

Reimplements: com.inscoper.nbo.NBOBaseClass.getTypeName

function getXMLName¶

public String getXMLName()

Returns the XML element name corresponding to this class.

Return: The XML element name

Reimplements: com.inscoper.nbo.NBOBaseClass.getXMLName

function getNBOType¶

public ENBOType getNBOType()

Returns the NBO Type corresponding to this class.

Return: The NBO Type value

Reimplements: com.inscoper.nbo.NBOBaseClass.getNBOType

function getChildren¶

public NBOBaseClassVector getChildren()

Returns a list of all classes derived from this class.

Return: The list of derived classes

Reimplements: com.inscoper.nbo.NBOBaseClass.getChildren

function getSubElements¶

public NBOBaseClassVector getSubElements()

Returns a list of all child elements contained in this class.

Return: The list of child classes

Reimplements: com.inscoper.nbo.NBOBaseClass.getSubElements

function fromJsonFile¶

public void fromJsonFile(
    String path,
    boolean validate
)

Populates this object from a JSON file.

Parameters:

path The path to the JSON file
validate If true, validates constraints on value. Default is true.

function fromJsonFile¶

public void fromJsonFile(
    String path
)

Populates this object from a JSON file.

Parameters:

path The path to the JSON file

function fromJsonString¶

public void fromJsonString(
    String json_string,
    boolean validate
)

Populates this object from a JSON string.

Parameters:

json_string The JSON content as a string
validate If true, validates constraints on value. Default is true.

function fromJsonString¶

public void fromJsonString(
    String json_string
)

Populates this object from a JSON string.

Parameters:

json_string The JSON content as a string

function fromXmlFile¶

public void fromXmlFile(
    String path,
    boolean validate
)

Populates this object from a XML file.

Parameters:

path The path to the XML file
validate If true, validates constraints on value. Default is true.

function fromXmlFile¶

public void fromXmlFile(
    String path
)

Populates this object from a XML file.

Parameters:

path The path to the XML file

function fromXmlString¶

public void fromXmlString(
    String xml_string,
    boolean validate
)

Populates this object from a XML string.

Parameters:

xml_string The XML content as a string
validate If true, validates constraints on value. Default is true.

function fromXmlString¶

public void fromXmlString(
    String xml_string
)

Populates this object from a XML string.

Parameters:

xml_string The XML content as a string

function toXmlFile¶

public void toXmlFile(
    String filename,
    boolean validate
)

Serializes this object to an XML file.

Parameters:

filename The path to the output XML file
validate If true, validates constraints on value. Default is true.

function toXmlFile¶

public void toXmlFile(
    String filename
)

Serializes this object to an XML file.

Parameters:

filename The path to the output XML file

function toXmlString¶

public String toXmlString(
    boolean validate
)

Serializes this object to an XML string.

Parameters:

validate If true, validates constraints on value. Default is true.

Return: A string containing the XML representation of this object

function toXmlString¶

public String toXmlString()

Serializes this object to an XML string.

Return: A string containing the XML representation of this object

function setID¶

public void setID(
    ImageID_Type value,
    boolean validate
)

Sets the value of the ID attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

A unique identifier for this Image.

function setID¶

public void setID(
    ImageID_Type value
)

Sets the value of the ID attribute.

Parameters:

value The value to set

A unique identifier for this Image.

function getID¶

public ImageID_Type getID()

Returns the value of the ID attribute.

Return: The value of the attribute

A unique identifier for this Image.

function resetID¶

public void resetID()

Resets the ID attribute to an unset state.

A unique identifier for this Image.

function hasID¶

public boolean hasID()

Checks whether the optional ID attribute is present.

Return: true if the optional attribute has been set, false otherwise

A unique identifier for this Image.

function setName¶

public void setName(
    Denomination_Type value,
    boolean validate
)

Sets the value of the Name attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

A user assigned name for this Image.

function setName¶

public void setName(
    Denomination_Type value
)

Sets the value of the Name attribute.

Parameters:

value The value to set

A user assigned name for this Image.

function getName¶

public Denomination_Type getName()

Returns the value of the Name attribute.

Return: The value of the attribute

A user assigned name for this Image.

function resetName¶

public void resetName()

Resets the Name attribute to an unset state.

A user assigned name for this Image.

function hasName¶

public boolean hasName()

Checks whether the optional Name attribute is present.

Return: true if the optional attribute has been set, false otherwise

A user assigned name for this Image.

function setAcquisitionDate¶

public void setAcquisitionDate(
    String value,
    boolean validate
)

Sets the value of the AcquisitionDate attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

The Date in which this Image was Acquired.

function setAcquisitionDate¶

public void setAcquisitionDate(
    String value
)

Sets the value of the AcquisitionDate attribute.

Parameters:

value The value to set

The Date in which this Image was Acquired.

function getAcquisitionDate¶

public String getAcquisitionDate()

Returns the value of the AcquisitionDate attribute.

Return: The value of the attribute

The Date in which this Image was Acquired.

function resetAcquisitionDate¶

public void resetAcquisitionDate()

Resets the AcquisitionDate attribute to an unset state.

The Date in which this Image was Acquired.

function hasAcquisitionDate¶

public boolean hasAcquisitionDate()

Checks whether the AcquisitionDate attribute is present.

Return: true if the attribute has been set, false otherwise

The Date in which this Image was Acquired.

function setInstrumentRef¶

public void setInstrumentRef(
    InstrumentRef value,
    boolean validate
)

Sets the value of the InstrumentRef element.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

No description available in the XSD standard.

function setInstrumentRef¶

public void setInstrumentRef(
    InstrumentRef value
)

Sets the value of the InstrumentRef element.

Parameters:

value The value to set

No description available in the XSD standard.

function getInstrumentRef¶

public InstrumentRef getInstrumentRef()

Returns the value of the InstrumentRef element.

Return: The value of the element

No description available in the XSD standard.

function resetInstrumentRef¶

public void resetInstrumentRef()

Resets the InstrumentRef element to an unset state.

No description available in the XSD standard.

function hasInstrumentRef¶

public boolean hasInstrumentRef()

Checks whether the optional InstrumentRef element is present.

Return: true if the optional attribute has been set, false otherwise

No description available in the XSD standard.

function setExperimentRef¶

public void setExperimentRef(
    ExperimentRef value,
    boolean validate
)

Sets the value of the ExperimentRef element.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

This empty element refers to the Experiment during which this Image was acquired.

function setExperimentRef¶

public void setExperimentRef(
    ExperimentRef value
)

Sets the value of the ExperimentRef element.

Parameters:

value The value to set

This empty element refers to the Experiment during which this Image was acquired.

function getExperimentRef¶

public ExperimentRef getExperimentRef()

Returns the value of the ExperimentRef element.

Return: The value of the element

This empty element refers to the Experiment during which this Image was acquired.

function resetExperimentRef¶

public void resetExperimentRef()

Resets the ExperimentRef element to an unset state.

This empty element refers to the Experiment during which this Image was acquired.

function hasExperimentRef¶

public boolean hasExperimentRef()

Checks whether the optional ExperimentRef element is present.

Return: true if the optional attribute has been set, false otherwise

This empty element refers to the Experiment during which this Image was acquired.

function setExperimenterRef_List¶

public void setExperimenterRef_List(
    ExperimenterRefVector value,
    boolean validate
)

Sets the list of ExperimenterRef elements.

Parameters:

value The new list of ExperimenterRef elements
validate If true, validates constraints on value. Default is true.

No description available in the XSD standard.

function setExperimenterRef_List¶

public void setExperimenterRef_List(
    ExperimenterRefVector value
)

Sets the list of ExperimenterRef elements.

Parameters:

value The new list of ExperimenterRef elements

No description available in the XSD standard.

function getExperimenterRef_List¶

public ExperimenterRefVector getExperimenterRef_List()

Returns the list of ExperimenterRef elements.

Return: The list of ExperimenterRef elements

No description available in the XSD standard.

function addToExperimenterRef_List¶

public void addToExperimenterRef_List(
    ExperimenterRef value,
    boolean validate
)

Adds a new ExperimenterRef element to this object.

Parameters:

value The element to add
validate If true, validates constraints on value. Default is true.

No description available in the XSD standard.

function addToExperimenterRef_List¶

public void addToExperimenterRef_List(
    ExperimenterRef value
)

Adds a new ExperimenterRef element to this object.

Parameters:

value The element to add

No description available in the XSD standard.

function clearExperimenterRef_List¶

public void clearExperimenterRef_List()

Clear the list of ExperimenterRef.

No description available in the XSD standard.

function setSampleRef_List¶

public void setSampleRef_List(
    SampleRefVector value,
    boolean validate
)

Sets the list of SampleRef elements.

Parameters:

value The new list of SampleRef elements
validate If true, validates constraints on value. Default is true.

This empty element refers to the Sample that was imaged in this Image Acquisition.

function setSampleRef_List¶

public void setSampleRef_List(
    SampleRefVector value
)

Sets the list of SampleRef elements.

Parameters:

value The new list of SampleRef elements

This empty element refers to the Sample that was imaged in this Image Acquisition.

function getSampleRef_List¶

public SampleRefVector getSampleRef_List()

Returns the list of SampleRef elements.

Return: The list of SampleRef elements

This empty element refers to the Sample that was imaged in this Image Acquisition.

function addToSampleRef_List¶

public void addToSampleRef_List(
    SampleRef value,
    boolean validate
)

Adds a new SampleRef element to this object.

Parameters:

value The element to add
validate If true, validates constraints on value. Default is true.

This empty element refers to the Sample that was imaged in this Image Acquisition.

function addToSampleRef_List¶

public void addToSampleRef_List(
    SampleRef value
)

Adds a new SampleRef element to this object.

Parameters:

value The element to add

This empty element refers to the Sample that was imaged in this Image Acquisition.

function clearSampleRef_List¶

public void clearSampleRef_List()

Clear the list of SampleRef.

This empty element refers to the Sample that was imaged in this Image Acquisition.

function setExperimenterGroupRef_List¶

public void setExperimenterGroupRef_List(
    ExperimenterGroupRefVector value,
    boolean validate
)

Sets the list of ExperimenterGroupRef elements.

Parameters:

value The new list of ExperimenterGroupRef elements
validate If true, validates constraints on value. Default is true.

No description available in the XSD standard.

function setExperimenterGroupRef_List¶

public void setExperimenterGroupRef_List(
    ExperimenterGroupRefVector value
)

Sets the list of ExperimenterGroupRef elements.

Parameters:

value The new list of ExperimenterGroupRef elements

No description available in the XSD standard.

function getExperimenterGroupRef_List¶

public ExperimenterGroupRefVector getExperimenterGroupRef_List()

Returns the list of ExperimenterGroupRef elements.

Return: The list of ExperimenterGroupRef elements

No description available in the XSD standard.

function addToExperimenterGroupRef_List¶

public void addToExperimenterGroupRef_List(
    ExperimenterGroupRef value,
    boolean validate
)

Adds a new ExperimenterGroupRef element to this object.

Parameters:

value The element to add
validate If true, validates constraints on value. Default is true.

No description available in the XSD standard.

function addToExperimenterGroupRef_List¶

public void addToExperimenterGroupRef_List(
    ExperimenterGroupRef value
)

Adds a new ExperimenterGroupRef element to this object.

Parameters:

value The element to add

No description available in the XSD standard.

function clearExperimenterGroupRef_List¶

public void clearExperimenterGroupRef_List()

Clear the list of ExperimenterGroupRef.

No description available in the XSD standard.

function setROIRef_List¶

public void setROIRef_List(
    ROIRefVector value,
    boolean validate
)

Sets the list of ROIRef elements.

Parameters:

value The new list of ROIRef elements
validate If true, validates constraints on value. Default is true.

This empty element refers to any predefined four dimensional ROI (Region of Interest) that is associated with this Image.

function setROIRef_List¶

public void setROIRef_List(
    ROIRefVector value
)

Sets the list of ROIRef elements.

Parameters:

value The new list of ROIRef elements

This empty element refers to any predefined four dimensional ROI (Region of Interest) that is associated with this Image.

function getROIRef_List¶

public ROIRefVector getROIRef_List()

Returns the list of ROIRef elements.

Return: The list of ROIRef elements

This empty element refers to any predefined four dimensional ROI (Region of Interest) that is associated with this Image.

function addToROIRef_List¶

public void addToROIRef_List(
    ROIRef value,
    boolean validate
)

Adds a new ROIRef element to this object.

Parameters:

value The element to add
validate If true, validates constraints on value. Default is true.

This empty element refers to any predefined four dimensional ROI (Region of Interest) that is associated with this Image.

function addToROIRef_List¶

public void addToROIRef_List(
    ROIRef value
)

Adds a new ROIRef element to this object.

Parameters:

value The element to add

This empty element refers to any predefined four dimensional ROI (Region of Interest) that is associated with this Image.

function clearROIRef_List¶

public void clearROIRef_List()

Clear the list of ROIRef.

This empty element refers to any predefined four dimensional ROI (Region of Interest) that is associated with this Image.

function setStageInsertRef_List¶

public void setStageInsertRef_List(
    StageInsertRefVector value,
    boolean validate
)

Sets the list of StageInsertRef elements.

Parameters:

value The new list of StageInsertRef elements
validate If true, validates constraints on value. Default is true.

No description available in the XSD standard.

function setStageInsertRef_List¶

public void setStageInsertRef_List(
    StageInsertRefVector value
)

Sets the list of StageInsertRef elements.

Parameters:

value The new list of StageInsertRef elements

No description available in the XSD standard.

function getStageInsertRef_List¶

public StageInsertRefVector getStageInsertRef_List()

Returns the list of StageInsertRef elements.

Return: The list of StageInsertRef elements

No description available in the XSD standard.

function addToStageInsertRef_List¶

public void addToStageInsertRef_List(
    StageInsertRef value,
    boolean validate
)

Adds a new StageInsertRef element to this object.

Parameters:

value The element to add
validate If true, validates constraints on value. Default is true.

No description available in the XSD standard.

function addToStageInsertRef_List¶

public void addToStageInsertRef_List(
    StageInsertRef value
)

Adds a new StageInsertRef element to this object.

Parameters:

value The element to add

No description available in the XSD standard.

function clearStageInsertRef_List¶

public void clearStageInsertRef_List()

Clear the list of StageInsertRef.

No description available in the XSD standard.

function setFocusStabilizationDeviceRef_List¶

public void setFocusStabilizationDeviceRef_List(
    FocusStabilizationDeviceRefVector value,
    boolean validate
)

Sets the list of FocusStabilizationDeviceRef elements.

Parameters:

value The new list of FocusStabilizationDeviceRef elements
validate If true, validates constraints on value. Default is true.

This empty element refers to the optional Focus Stabilization device that was used for the Acquisition of this Image.

function setFocusStabilizationDeviceRef_List¶

public void setFocusStabilizationDeviceRef_List(
    FocusStabilizationDeviceRefVector value
)

Sets the list of FocusStabilizationDeviceRef elements.

Parameters:

value The new list of FocusStabilizationDeviceRef elements

This empty element refers to the optional Focus Stabilization device that was used for the Acquisition of this Image.

function getFocusStabilizationDeviceRef_List¶

public FocusStabilizationDeviceRefVector getFocusStabilizationDeviceRef_List()

Returns the list of FocusStabilizationDeviceRef elements.

Return: The list of FocusStabilizationDeviceRef elements

This empty element refers to the optional Focus Stabilization device that was used for the Acquisition of this Image.

function addToFocusStabilizationDeviceRef_List¶

public void addToFocusStabilizationDeviceRef_List(
    FocusStabilizationDeviceRef value,
    boolean validate
)

Adds a new FocusStabilizationDeviceRef element to this object.

Parameters:

value The element to add
validate If true, validates constraints on value. Default is true.

This empty element refers to the optional Focus Stabilization device that was used for the Acquisition of this Image.

function addToFocusStabilizationDeviceRef_List¶

public void addToFocusStabilizationDeviceRef_List(
    FocusStabilizationDeviceRef value
)

Adds a new FocusStabilizationDeviceRef element to this object.

Parameters:

value The element to add

This empty element refers to the optional Focus Stabilization device that was used for the Acquisition of this Image.

function clearFocusStabilizationDeviceRef_List¶

public void clearFocusStabilizationDeviceRef_List()

Clear the list of FocusStabilizationDeviceRef.

This empty element refers to the optional Focus Stabilization device that was used for the Acquisition of this Image.

function setAcquisitionSoftwareRef_List¶

public void setAcquisitionSoftwareRef_List(
    AcquisitionSoftwareRefVector value,
    boolean validate
)

Sets the list of AcquisitionSoftwareRef elements.

Parameters:

value The new list of AcquisitionSoftwareRef elements
validate If true, validates constraints on value. Default is true.

No description available in the XSD standard.

function setAcquisitionSoftwareRef_List¶

public void setAcquisitionSoftwareRef_List(
    AcquisitionSoftwareRefVector value
)

Sets the list of AcquisitionSoftwareRef elements.

Parameters:

value The new list of AcquisitionSoftwareRef elements

No description available in the XSD standard.

function getAcquisitionSoftwareRef_List¶

public AcquisitionSoftwareRefVector getAcquisitionSoftwareRef_List()

Returns the list of AcquisitionSoftwareRef elements.

Return: The list of AcquisitionSoftwareRef elements

No description available in the XSD standard.

function addToAcquisitionSoftwareRef_List¶

public void addToAcquisitionSoftwareRef_List(
    AcquisitionSoftwareRef value,
    boolean validate
)

Adds a new AcquisitionSoftwareRef element to this object.

Parameters:

value The element to add
validate If true, validates constraints on value. Default is true.

No description available in the XSD standard.

function addToAcquisitionSoftwareRef_List¶

public void addToAcquisitionSoftwareRef_List(
    AcquisitionSoftwareRef value
)

Adds a new AcquisitionSoftwareRef element to this object.

Parameters:

value The element to add

No description available in the XSD standard.

function clearAcquisitionSoftwareRef_List¶

public void clearAcquisitionSoftwareRef_List()

Clear the list of AcquisitionSoftwareRef.

No description available in the XSD standard.

function setDescription¶

public void setDescription(
    Description value,
    boolean validate
)

Sets the value of the Description element.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

No description available in the XSD standard.

function setDescription¶

public void setDescription(
    Description value
)

Sets the value of the Description element.

Parameters:

value The value to set

No description available in the XSD standard.

function getDescription¶

public Description getDescription()

Returns the value of the Description element.

Return: The value of the element

No description available in the XSD standard.

function resetDescription¶

public void resetDescription()

Resets the Description element to an unset state.

No description available in the XSD standard.

function hasDescription¶

public boolean hasDescription()

Checks whether the optional Description element is present.

Return: true if the optional attribute has been set, false otherwise

No description available in the XSD standard.

function setImagingEnvironment_List¶

public void setImagingEnvironment_List(
    ImagingEnvironmentVector value,
    boolean validate
)

Sets the list of ImagingEnvironment elements.

Parameters:

value The new list of ImagingEnvironment elements
validate If true, validates constraints on value. Default is true.

No description available in the XSD standard.

function setImagingEnvironment_List¶

public void setImagingEnvironment_List(
    ImagingEnvironmentVector value
)

Sets the list of ImagingEnvironment elements.

Parameters:

value The new list of ImagingEnvironment elements

No description available in the XSD standard.

function getImagingEnvironment_List¶

public ImagingEnvironmentVector getImagingEnvironment_List()

Returns the list of ImagingEnvironment elements.

Return: The list of ImagingEnvironment elements

No description available in the XSD standard.

function addToImagingEnvironment_List¶

public void addToImagingEnvironment_List(
    ImagingEnvironment value,
    boolean validate
)

Adds a new ImagingEnvironment element to this object.

Parameters:

value The element to add
validate If true, validates constraints on value. Default is true.

No description available in the XSD standard.

function addToImagingEnvironment_List¶

public void addToImagingEnvironment_List(
    ImagingEnvironment value
)

Adds a new ImagingEnvironment element to this object.

Parameters:

value The element to add

No description available in the XSD standard.

function clearImagingEnvironment_List¶

public void clearImagingEnvironment_List()

Clear the list of ImagingEnvironment.

No description available in the XSD standard.

function setMicroscopeStandSettings¶

public void setMicroscopeStandSettings(
    MicroscopeStandSettings value,
    boolean validate
)

Sets the value of the MicroscopeStandSettings element.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

No description available in the XSD standard.

function setMicroscopeStandSettings¶

public void setMicroscopeStandSettings(
    MicroscopeStandSettings value
)

Sets the value of the MicroscopeStandSettings element.

Parameters:

value The value to set

No description available in the XSD standard.

function getMicroscopeStandSettings¶

public MicroscopeStandSettings getMicroscopeStandSettings()

Returns the value of the MicroscopeStandSettings element.

Return: The value of the element

No description available in the XSD standard.

function resetMicroscopeStandSettings¶

public void resetMicroscopeStandSettings()

Resets the MicroscopeStandSettings element to an unset state.

No description available in the XSD standard.

function hasMicroscopeStandSettings¶

public boolean hasMicroscopeStandSettings()

Checks whether the optional MicroscopeStandSettings element is present.

Return: true if the optional attribute has been set, false otherwise

No description available in the XSD standard.

function setMicroscopeTableSettings_List¶

public void setMicroscopeTableSettings_List(
    MicroscopeTableSettingsVector value,
    boolean validate
)

Sets the list of MicroscopeTableSettings elements.

Parameters:

value The new list of MicroscopeTableSettings elements
validate If true, validates constraints on value. Default is true.

No description available in the XSD standard.

function setMicroscopeTableSettings_List¶

public void setMicroscopeTableSettings_List(
    MicroscopeTableSettingsVector value
)

Sets the list of MicroscopeTableSettings elements.

Parameters:

value The new list of MicroscopeTableSettings elements

No description available in the XSD standard.

function getMicroscopeTableSettings_List¶

public MicroscopeTableSettingsVector getMicroscopeTableSettings_List()

Returns the list of MicroscopeTableSettings elements.

Return: The list of MicroscopeTableSettings elements

No description available in the XSD standard.

function addToMicroscopeTableSettings_List¶

public void addToMicroscopeTableSettings_List(
    MicroscopeTableSettings value,
    boolean validate
)

Adds a new MicroscopeTableSettings element to this object.

Parameters:

value The element to add
validate If true, validates constraints on value. Default is true.

No description available in the XSD standard.

function addToMicroscopeTableSettings_List¶

public void addToMicroscopeTableSettings_List(
    MicroscopeTableSettings value
)

Adds a new MicroscopeTableSettings element to this object.

Parameters:

value The element to add

No description available in the XSD standard.

function clearMicroscopeTableSettings_List¶

public void clearMicroscopeTableSettings_List()

Clear the list of MicroscopeTableSettings.

No description available in the XSD standard.

function setObjectiveSettings¶

public void setObjectiveSettings(
    ObjectiveSettings value,
    boolean validate
)

Sets the value of the ObjectiveSettings element.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

No description available in the XSD standard.

function setObjectiveSettings¶

public void setObjectiveSettings(
    ObjectiveSettings value
)

Sets the value of the ObjectiveSettings element.

Parameters:

value The value to set

No description available in the XSD standard.

function getObjectiveSettings¶

public ObjectiveSettings getObjectiveSettings()

Returns the value of the ObjectiveSettings element.

Return: The value of the element

No description available in the XSD standard.

function resetObjectiveSettings¶

public void resetObjectiveSettings()

Resets the ObjectiveSettings element to an unset state.

No description available in the XSD standard.

function hasObjectiveSettings¶

public boolean hasObjectiveSettings()

Checks whether the optional ObjectiveSettings element is present.

Return: true if the optional attribute has been set, false otherwise

No description available in the XSD standard.

function setStageLabel_List¶

public void setStageLabel_List(
    StageLabelVector value,
    boolean validate
)

Sets the list of StageLabel elements.

Parameters:

value The new list of StageLabel elements
validate If true, validates constraints on value. Default is true.

No description available in the XSD standard.

function setStageLabel_List¶

public void setStageLabel_List(
    StageLabelVector value
)

Sets the list of StageLabel elements.

Parameters:

value The new list of StageLabel elements

No description available in the XSD standard.

function getStageLabel_List¶

public StageLabelVector getStageLabel_List()

Returns the list of StageLabel elements.

Return: The list of StageLabel elements

No description available in the XSD standard.

function addToStageLabel_List¶

public void addToStageLabel_List(
    StageLabel value,
    boolean validate
)

Adds a new StageLabel element to this object.

Parameters:

value The element to add
validate If true, validates constraints on value. Default is true.

No description available in the XSD standard.

function addToStageLabel_List¶

public void addToStageLabel_List(
    StageLabel value
)

Adds a new StageLabel element to this object.

Parameters:

value The element to add

No description available in the XSD standard.

function clearStageLabel_List¶

public void clearStageLabel_List()

Clear the list of StageLabel.

No description available in the XSD standard.

function setSamplePositioningSettings_List¶

public void setSamplePositioningSettings_List(
    SamplePositioningSettingsVector value,
    boolean validate
)

Sets the list of SamplePositioningSettings elements.

Parameters:

value The new list of SamplePositioningSettings elements
validate If true, validates constraints on value. Default is true.

No description available in the XSD standard.

function setSamplePositioningSettings_List¶

public void setSamplePositioningSettings_List(
    SamplePositioningSettingsVector value
)

Sets the list of SamplePositioningSettings elements.

Parameters:

value The new list of SamplePositioningSettings elements

No description available in the XSD standard.

function getSamplePositioningSettings_List¶

public SamplePositioningSettingsVector getSamplePositioningSettings_List()

Returns the list of SamplePositioningSettings elements.

Return: The list of SamplePositioningSettings elements

No description available in the XSD standard.

function addToSamplePositioningSettings_List¶

public void addToSamplePositioningSettings_List(
    SamplePositioningSettings value,
    boolean validate
)

Adds a new SamplePositioningSettings element to this object.

Parameters:

value The element to add
validate If true, validates constraints on value. Default is true.

No description available in the XSD standard.

function addToSamplePositioningSettings_List¶

public void addToSamplePositioningSettings_List(
    SamplePositioningSettings value
)

Adds a new SamplePositioningSettings element to this object.

Parameters:

value The element to add

No description available in the XSD standard.

function clearSamplePositioningSettings_List¶

public void clearSamplePositioningSettings_List()

Clear the list of SamplePositioningSettings.

No description available in the XSD standard.

function setOpticalCalibration_List¶

public void setOpticalCalibration_List(
    OpticalCalibrationVector value,
    boolean validate
)

Sets the list of OpticalCalibration elements.

Parameters:

value The new list of OpticalCalibration elements
validate If true, validates constraints on value. Default is true.

No description available in the XSD standard.

function setOpticalCalibration_List¶

public void setOpticalCalibration_List(
    OpticalCalibrationVector value
)

Sets the list of OpticalCalibration elements.

Parameters:

value The new list of OpticalCalibration elements

No description available in the XSD standard.

function getOpticalCalibration_List¶

public OpticalCalibrationVector getOpticalCalibration_List()

Returns the list of OpticalCalibration elements.

Return: The list of OpticalCalibration elements

No description available in the XSD standard.

function addToOpticalCalibration_List¶

public void addToOpticalCalibration_List(
    OpticalCalibration value,
    boolean validate
)

Adds a new OpticalCalibration element to this object.

Parameters:

value The element to add
validate If true, validates constraints on value. Default is true.

No description available in the XSD standard.

function addToOpticalCalibration_List¶

public void addToOpticalCalibration_List(
    OpticalCalibration value
)

Adds a new OpticalCalibration element to this object.

Parameters:

value The element to add

No description available in the XSD standard.

function clearOpticalCalibration_List¶

public void clearOpticalCalibration_List()

Clear the list of OpticalCalibration.

No description available in the XSD standard.

function setDetectorCalibration_List¶

public void setDetectorCalibration_List(
    DetectorCalibrationVector value,
    boolean validate
)

Sets the list of DetectorCalibration elements.

Parameters:

value The new list of DetectorCalibration elements
validate If true, validates constraints on value. Default is true.

No description available in the XSD standard.

function setDetectorCalibration_List¶

public void setDetectorCalibration_List(
    DetectorCalibrationVector value
)

Sets the list of DetectorCalibration elements.

Parameters:

value The new list of DetectorCalibration elements

No description available in the XSD standard.

function getDetectorCalibration_List¶

public DetectorCalibrationVector getDetectorCalibration_List()

Returns the list of DetectorCalibration elements.

Return: The list of DetectorCalibration elements

No description available in the XSD standard.

function addToDetectorCalibration_List¶

public void addToDetectorCalibration_List(
    DetectorCalibration value,
    boolean validate
)

Adds a new DetectorCalibration element to this object.

Parameters:

value The element to add
validate If true, validates constraints on value. Default is true.

No description available in the XSD standard.

function addToDetectorCalibration_List¶

public void addToDetectorCalibration_List(
    DetectorCalibration value
)

Adds a new DetectorCalibration element to this object.

Parameters:

value The element to add

No description available in the XSD standard.

function clearDetectorCalibration_List¶

public void clearDetectorCalibration_List()

Clear the list of DetectorCalibration.

No description available in the XSD standard.

function setPixels¶

public void setPixels(
    Pixels value,
    boolean validate
)

Sets the value of the Pixels element.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

No description available in the XSD standard.

function setPixels¶

public void setPixels(
    Pixels value
)

Sets the value of the Pixels element.

Parameters:

value The value to set

No description available in the XSD standard.

function getPixels¶

public Pixels getPixels()

Returns the value of the Pixels element.

Return: The value of the element

No description available in the XSD standard.

function resetPixels¶

public void resetPixels()

Resets the Pixels element to an unset state.

No description available in the XSD standard.

function hasPixels¶

public boolean hasPixels()

Checks whether the optional Pixels element is present.

Return: true if the optional attribute has been set, false otherwise

No description available in the XSD standard.

function setAnnotationRef_List¶

public void setAnnotationRef_List(
    AnnotationRefVector value,
    boolean validate
)

Sets the list of AnnotationRef elements.

Parameters:

value The new list of AnnotationRef elements
validate If true, validates constraints on value. Default is true.

This is a simple multi-line comment or annotation describing this component.

function setAnnotationRef_List¶

public void setAnnotationRef_List(
    AnnotationRefVector value
)

Sets the list of AnnotationRef elements.

Parameters:

value The new list of AnnotationRef elements

This is a simple multi-line comment or annotation describing this component.

function getAnnotationRef_List¶

public AnnotationRefVector getAnnotationRef_List()

Returns the list of AnnotationRef elements.

Return: The list of AnnotationRef elements

This is a simple multi-line comment or annotation describing this component.

function addToAnnotationRef_List¶

public void addToAnnotationRef_List(
    AnnotationRef value,
    boolean validate
)

Adds a new AnnotationRef element to this object.

Parameters:

value The element to add
validate If true, validates constraints on value. Default is true.

This is a simple multi-line comment or annotation describing this component.

function addToAnnotationRef_List¶

public void addToAnnotationRef_List(
    AnnotationRef value
)

Adds a new AnnotationRef element to this object.

Parameters:

value The element to add

This is a simple multi-line comment or annotation describing this component.

function clearAnnotationRef_List¶

public void clearAnnotationRef_List()

Clear the list of AnnotationRef.

This is a simple multi-line comment or annotation describing this component.

function __internal_create¶

public static Image __internal_create(
    long cPtr,
    boolean own
)

Reimplements: com.inscoper.nbo.NBOBaseClass.__internal_create

function fromBase¶

public static Image fromBase(
    NBOBaseClass base
)

Cast a NBOBaseClass to a CMOS.

Parameters:

base The base class to cast

Return: The casted element, or nullptr if the cast fails

function getAcquisitionDateAllowedValues¶

public static StringSet getAcquisitionDateAllowedValues()

Returns the allowed values for this attribut.

Return: The list of allowed values

The Date in which this Image was Acquired.

Protected Functions Documentation¶

function Image¶

protected Image(
    long cPtr,
    boolean cMemoryOwn
)

function swigSetCMemOwn¶

protected void swigSetCMemOwn(
    boolean own
)

Reimplements: com.inscoper.nbo.NBOBaseClass.swigSetCMemOwn

function finalize¶

protected void finalize()

Reimplements: com.inscoper.nbo.NBOBaseClass.finalize

function getCPtr¶

protected static long getCPtr(
    Image obj
)

Updated on 2026-06-22 at 17:06:26 +0200